M

RebarSpliceUtils.SpliceRebar

Description:
Splice a rebar with a list of RebarSpliceGeometry.

Overloads (3):

SpliceRebar

SpliceRebar(Document,ElementId,RebarSpliceOptions,IList[RebarSpliceGeometry])

SpliceRebar(Document,ElementId,RebarSpliceOptions,Line,ElementId)

SpliceRebar(Document,ElementId,RebarSpliceOptions,Line,XYZ)

public static IList<ElementId> SpliceRebar(
	Document document,
	ElementId rebarIdToSplit,
	RebarSpliceOptions spliceOptions,
	IList<RebarSpliceGeometry> spliceGeometries
)

Public Shared Function SpliceRebar ( 
	document As Document,
	rebarIdToSplit As ElementId,
	spliceOptions As RebarSpliceOptions,
	spliceGeometries As IList(Of RebarSpliceGeometry)
) As IList(Of ElementId)

public:
static IList<ElementId^>^ SpliceRebar(
	Document^ document, 
	ElementId^ rebarIdToSplit, 
	RebarSpliceOptions^ spliceOptions, 
	IList<RebarSpliceGeometry^>^ spliceGeometries
)

static member SpliceRebar : 
        document : Document * 
        rebarIdToSplit : ElementId * 
        spliceOptions : RebarSpliceOptions * 
        spliceGeometries : IList<RebarSpliceGeometry> -> IList<ElementId>

Document

document

The document
ElementId

rebarIdToSplit

Rebar id to split.
RebarSpliceOptions

spliceOptions

The rebar splice options.
IList<RebarSpliceGeometry>

spliceGeometries

A list of RebarSpliceGeometry that indicates where the rebar will be spliced.

Return Value IList<ElementId> Returns the ids of the rebars that are considered to be spliced.

ArgumentException

Free Form Rebars, or Shape Driven Rebars that are Multiplanar or have a shape that whose definition is RebarShapeDefinitionByArc can't be spliced. Also, if the Rebar is member of a Group it cannot be spliced.
ArgumentNullException

A non-optional argument was null